Skip to main content

Assets, Providers, and Datasets

Three identifiers connect Platform API entities with Data API records: an asset, a provider, and a dataset.

Assets​

An asset represents an operational entity such as a well, rig, frac fleet, or drillout unit. Platform API responses include both a platform entity ID and, where applicable, an asset_id used by datasets.

For most well-data workflows:

  1. Query GET https://api.corva.ai/v2/wells.
  2. Read attributes.asset_id from the selected well.
  3. Use that value in a Data API query such as {"asset_id": 12345}.

Do not assume the Platform API resource ID and dataset asset_id are interchangeable.

You can also find a well through GET /v2/assets?types[]=well. In that legacy asset-hierarchy response, the top-level resource id is the dataset asset ID. See Find Wells and Asset IDs for when to use each endpoint.

Providers​

The provider identifies the company or system that owns the dataset definition. It forms the first path parameter in a Data API request:

/api/v1/data/{provider}/{dataset}/

For example, corva is the provider in corva#wits:

/api/v1/data/corva/wits/

Datasets​

A dataset is a named collection of records with an expected structure and indexing strategy. Common categories include:

  • Time-based: records indexed by time, usually with a Unix timestamp.
  • Depth-based: records associated with measured depth.
  • Reference: records associated with a company or shared configuration.

Dataset names are written as provider#dataset when discussed as an identifier, but the API path separates them with slashes.

Dataset identifierAPI path
corva#wits/api/v1/data/corva/wits/
corva#completion.wits/api/v1/data/corva/completion.wits/
corva#drillout.wits/api/v1/data/corva/drillout.wits/

Discover available datasets​

Use the Data API dataset endpoints when you need to search or inspect accessible datasets:

  • GET /api/v1/dataset/?search={text} searches dataset names.
  • GET /api/v1/dataset/company/ lists datasets available to the authenticated company.
  • GET /api/v1/dataset/{provider}/{name}/ returns details for one dataset.

Availability is determined by the permissions attached to your API key or Bearer-token user.